Get Dead Letter

Route

/v2/streaming/profiles/{profile_id}/dead-letter

Description

Retrieve dead letter queue information for a streaming profile. Dead letters contain records that failed to be delivered.

Method

GET

Inputs

Parameter	Type	Required	Description
profile_id	string	Yes	The unique identifier of the profile

Output

Field	Type	Description
resources	array[DeadLetter]	Array containing dead letter information
errors	array[Error]	Any errors encountered

Dead Letter Object Structure

Field	Type	Description
profile_id	string	Profile identifier
profile_name	string	Profile name
state	string	Dead letter state (ready, redrive_in_progress, etc.)
record_count	string	Number of dead letter records
oldest_undelivered	string	Timestamp of oldest undelivered record

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "profile_id": "profile-123",
      "profile_name": "Security Events Stream",
      "state": "ready",
      "record_count": "42",
      "oldest_undelivered": "2024-01-15T08:30:00Z"
    }
  ],
  "errors": []
}